package cn.zxhysy.booksmall.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;


/**
 * @className: Swagger2
 * @description:
 */
@Configuration
@EnableSwagger2
public class Swagger2 {

    /**
     * @description: swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
     */
    @Bean
    public Docket createRestApi() {

        // 为swagger添加header参数可供输入
//        ParameterBuilder userTokenHeader = new ParameterBuilder();
//        ParameterBuilder userIdHeader = new ParameterBuilder();
//        List<Parameter> pars = new ArrayList<Parameter>();
//        userTokenHeader.name("headerUserToken").description("userToken")
//				.modelRef(new ModelRef("string")).parameterType("header")
//				.required(false).build();
//		userIdHeader.name("headerUserId").description("userId")
//				.modelRef(new ModelRef("string")).parameterType("header")
//				.required(false).build();
//		pars.add(userTokenHeader.build());
//		pars.add(userIdHeader.build());

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("cn.zxhysy.booksmall.controller"))
                .paths(PathSelectors.any())
                .build();
//				.globalOperationParameters(pars);
    }

    /**
     * @description: 构建 api文档的信息
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 设置页面标题
                .title("使用swagger2构建后端api接口文档")
                // 设置联系人
                .contact(new Contact("zxh", "cn.zxhyys", "2506359151@qq.com"))
                // 描述
                .description("欢迎访问工程认证接口文档，这里是描述信息")
                // 定义版本号
                .version("1.0").build();
    }

}
